Quick Start

This is a short introduction to installing and using the SilverBullet AI plug with SilverBullet v2.

Installation

Run Library: Install and enter ghr:justyns/silverbullet-ai/PLUG.md (see Installation for more options)

Configuration

1. Set API Key

Add your API key to your Space Lua configuration:

config.set {
  ai = {
    keys = {
      OPENAI_API_KEY = "your-openai-key-here"
    }
  }
}

2. Configure AI Models

Configure one or more textModels, and optionally an image model and embeddings model. Example below is for OpenAI and DALL-E. You may also want to configure Chat Instructions at this time. See Providers for examples other than OpenAI, including self-hosted ones.

config.set {
  ai = {
    keys = {
      OPENAI_API_KEY = "your-openai-key-here"
    },
    imageModels = {
      {name = "dall-e-3", modelName = "dall-e-3", provider = "dalle"}
    },
    textModels = {
      {name = "gpt-4o", provider = "openai", modelName = "gpt-4o"},
      {name = "gpt-4o-mini", provider = "openai", modelName = "gpt-4o-mini"}
    },
    embeddingModels = {
      {name = "text-embedding-3-small", provider = "openai", modelName = "text-embedding-3-small"}
    },
    -- Chat section is optional, but may help provide better results
    chat = {
      userInformation = "I'm a software developer who likes taking notes.",
      userInstructions = "Please give short and concise responses. When providing code, do so in python unless requested otherwise."
    }
  }
}

Usage

Run AI: Select Text Model from Config, choose one of the models you just configured.

Note

If you only have one model configured, it will be selected automatically.

Open a new note, run AI: Chat on current page or press (CTRL|CMD)+SHIFT+ENTER to start a chat session.

Or try searching with AI: Search after configuring an Embedding model and re-indexing the space.

And that's it! Look at the other Commands available, as well as check out the Templated Prompts to go further.

Troubleshooting

If something didn't work right, try using the AI: Connectivity Test command and also checking your browser's javascript console.